splunk_acs_sdk.api package

Submodules

splunk_acs_sdk.api.allowlist_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.allowlist_api.AllowlistApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

add_subnets(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], add_subnets_request: Annotated[AddSubnetsRequest, FieldInfo(annotation=NoneType, required=True, description='the new subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → WarningResponse

add subnets to the allowlist for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • add_subnets_request (AddSubnetsRequest) – the new subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

add_subnets_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], add_subnets_request: Annotated[AddSubnetsRequest, FieldInfo(annotation=NoneType, required=True, description='the new subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[WarningResponse]

add_subnets

add subnets to the allowlist for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • add_subnets_request (AddSubnetsRequest) – the new subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

add_subnets_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], add_subnets_request: Annotated[AddSubnetsRequest, FieldInfo(annotation=NoneType, required=True, description='the new subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

add_subnets

add subnets to the allowlist for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • add_subnets_request (AddSubnetsRequest) – the new subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_allowlist_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the new subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → WarningResponse

add ipv6 subnets to the allowlist for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the new subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_allowlist_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the new subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[WarningResponse]

create_allowlist_v6

add ipv6 subnets to the allowlist for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the new subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_allowlist_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the new subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

create_allowlist_v6

add ipv6 subnets to the allowlist for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the new subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_allowlist_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], subnet: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnet to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → WarningResponse

delete an existing ipv6 subnet if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • subnet (str) – the ipv6 subnet to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_allowlist_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], subnet: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnet to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[WarningResponse]

delete_allowlist_v6

delete an existing ipv6 subnet if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • subnet (str) – the ipv6 subnet to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_allowlist_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], subnet: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnet to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_allowlist_v6

delete an existing ipv6 subnet if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • subnet (str) – the ipv6 subnet to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_allowlists_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnets to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → WarningResponse

delete existing ipv6 subnets (if they exists) from where the splunk cloud stack feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the ipv6 subnets to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_allowlists_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnets to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[WarningResponse]

delete_allowlists_v6

delete existing ipv6 subnets (if they exists) from where the splunk cloud stack feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the ipv6 subnets to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_allowlists_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnets to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_allowlists_v6

delete existing ipv6 subnets (if they exists) from where the splunk cloud stack feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the ipv6 subnets to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_subnet(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], subnet: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the subnet to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → WarningResponse

delete an existing ip subnet if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • subnet (str) – the subnet to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_subnet_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], subnet: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the subnet to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[WarningResponse]

delete_subnet

delete an existing ip subnet if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • subnet (str) – the subnet to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_subnet_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], subnet: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the subnet to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_subnet

delete an existing ip subnet if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • subnet (str) – the subnet to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_subnets(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], add_subnets_request: Annotated[AddSubnetsRequest, FieldInfo(annotation=NoneType, required=True, description='the subnets to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → WarningResponse

delete existing ip subnets (if they exists) from where the splunk cloud stack feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • add_subnets_request (AddSubnetsRequest) – the subnets to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_subnets_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], add_subnets_request: Annotated[AddSubnetsRequest, FieldInfo(annotation=NoneType, required=True, description='the subnets to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[WarningResponse]

delete_subnets

delete existing ip subnets (if they exists) from where the splunk cloud stack feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • add_subnets_request (AddSubnetsRequest) – the subnets to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_subnets_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], add_subnets_request: Annotated[AddSubnetsRequest, FieldInfo(annotation=NoneType, required=True, description='the subnets to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_subnets

delete existing ip subnets (if they exists) from where the splunk cloud stack feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • add_subnets_request (AddSubnetsRequest) – the subnets to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_allowlist(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → DescribeAllowlist200Response

describe the allowlist with its status and subnets from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_allowlist_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → DescribeAllowlistV6200Response

describe the allowlist with its status and ipv6 subnets from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_allowlist_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[DescribeAllowlistV6200Response]

describe_allowlist_v6

describe the allowlist with its status and ipv6 subnets from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_allowlist_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_allowlist_v6

describe the allowlist with its status and ipv6 subnets from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_allowlist_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[DescribeAllowlist200Response]

describe_allowlist

describe the allowlist with its status and subnets from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_allowlist_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_allowlist

describe the allowlist with its status and subnets from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.apps_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.apps_api.AppsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

describe_app(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → App

get an app

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_app_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[App]

describe_app

get an app

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_app_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_app

get an app

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

install_app(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], acs_legal_ack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='ACS-Legal-Ack is required for installing private apps')], splunkbase: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='is the app available in splunkbase')] = None, x_splunkbase_authorization: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Splunkbase sessionID')] = None, x_splunk_authorization: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The app inspect token')] = None, acs_licensing_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='ACS-Licensing-Ack is required for installing splunkbase apps')] = None, package: Annotated[Annotated[bytes, Strict(strict=True)] | Annotated[str, Strict(strict=True)] | Tuple[Annotated[str, Strict(strict=True)], Annotated[bytes, Strict(strict=True)]] | None, FieldInfo(annotation=NoneType, required=True, description='the pre-approved app package file in tar.gz format')] = None, token: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='the splunkbase authentication token')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → App

install an app

Parameters:

  • stack (str) – the stack name (required)

  • acs_legal_ack (str) – ACS-Legal-Ack is required for installing private apps (required)

  • splunkbase (bool) – is the app available in splunkbase

  • x_splunkbase_authorization (str) – Splunkbase sessionID

  • x_splunk_authorization (str) – The app inspect token

  • acs_licensing_ack (str) – ACS-Licensing-Ack is required for installing splunkbase apps

  • package (bytearray) – the pre-approved app package file in tar.gz format

  • token (str) – the splunkbase authentication token

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

install_app_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], acs_legal_ack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='ACS-Legal-Ack is required for installing private apps')], splunkbase: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='is the app available in splunkbase')] = None, x_splunkbase_authorization: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Splunkbase sessionID')] = None, x_splunk_authorization: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The app inspect token')] = None, acs_licensing_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='ACS-Licensing-Ack is required for installing splunkbase apps')] = None, package: Annotated[Annotated[bytes, Strict(strict=True)] | Annotated[str, Strict(strict=True)] | Tuple[Annotated[str, Strict(strict=True)], Annotated[bytes, Strict(strict=True)]] | None, FieldInfo(annotation=NoneType, required=True, description='the pre-approved app package file in tar.gz format')] = None, token: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='the splunkbase authentication token')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[App]

install_app

install an app

Parameters:

  • stack (str) – the stack name (required)

  • acs_legal_ack (str) – ACS-Legal-Ack is required for installing private apps (required)

  • splunkbase (bool) – is the app available in splunkbase

  • x_splunkbase_authorization (str) – Splunkbase sessionID

  • x_splunk_authorization (str) – The app inspect token

  • acs_licensing_ack (str) – ACS-Licensing-Ack is required for installing splunkbase apps

  • package (bytearray) – the pre-approved app package file in tar.gz format

  • token (str) – the splunkbase authentication token

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

install_app_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], acs_legal_ack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='ACS-Legal-Ack is required for installing private apps')], splunkbase: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='is the app available in splunkbase')] = None, x_splunkbase_authorization: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Splunkbase sessionID')] = None, x_splunk_authorization: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The app inspect token')] = None, acs_licensing_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='ACS-Licensing-Ack is required for installing splunkbase apps')] = None, package: Annotated[Annotated[bytes, Strict(strict=True)] | Annotated[str, Strict(strict=True)] | Tuple[Annotated[str, Strict(strict=True)], Annotated[bytes, Strict(strict=True)]] | None, FieldInfo(annotation=NoneType, required=True, description='the pre-approved app package file in tar.gz format')] = None, token: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='the splunkbase authentication token')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

install_app

install an app

Parameters:

  • stack (str) – the stack name (required)

  • acs_legal_ack (str) – ACS-Legal-Ack is required for installing private apps (required)

  • splunkbase (bool) – is the app available in splunkbase

  • x_splunkbase_authorization (str) – Splunkbase sessionID

  • x_splunk_authorization (str) – The app inspect token

  • acs_licensing_ack (str) – ACS-Licensing-Ack is required for installing splunkbase apps

  • package (bytearray) – the pre-approved app package file in tar.gz format

  • token (str) – the splunkbase authentication token

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_apps(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, splunkbase: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='filter apps based on splunkbase and non-splunkbase apps')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ListApps200Response

list apps available on the stacks

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • splunkbase (bool) – filter apps based on splunkbase and non-splunkbase apps

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_apps_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, splunkbase: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='filter apps based on splunkbase and non-splunkbase apps')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[ListApps200Response]

list_apps

list apps available on the stacks

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • splunkbase (bool) – filter apps based on splunkbase and non-splunkbase apps

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_apps_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, splunkbase: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='filter apps based on splunkbase and non-splunkbase apps')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_apps

list apps available on the stacks

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • splunkbase (bool) – filter apps based on splunkbase and non-splunkbase apps

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

uninstall_app(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

uninstall the app

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

uninstall_app_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

uninstall_app

uninstall the app

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

uninstall_app_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

uninstall_app

uninstall the app

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.apps_classic_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.apps_classic_api.AppsClassicApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

patch_app_classic(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], x_splunkbase_authorization: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The splunkbase sessionID')], acs_licensing_ack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='ACS-Licensing-Ack is required for updating splunkbase apps')], version: Annotated[str, Strict(strict=True)] | None = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → App

update an installed splunkbase apps

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • x_splunkbase_authorization (str) – The splunkbase sessionID (required)

  • acs_licensing_ack (str) – ACS-Licensing-Ack is required for updating splunkbase apps (required)

  • version (str)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_app_classic_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], x_splunkbase_authorization: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The splunkbase sessionID')], acs_licensing_ack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='ACS-Licensing-Ack is required for updating splunkbase apps')], version: Annotated[str, Strict(strict=True)] | None = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[App]

patch_app_classic

update an installed splunkbase apps

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • x_splunkbase_authorization (str) – The splunkbase sessionID (required)

  • acs_licensing_ack (str) – ACS-Licensing-Ack is required for updating splunkbase apps (required)

  • version (str)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_app_classic_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], x_splunkbase_authorization: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The splunkbase sessionID')], acs_licensing_ack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='ACS-Licensing-Ack is required for updating splunkbase apps')], version: Annotated[str, Strict(strict=True)] | None = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

patch_app_classic

update an installed splunkbase apps

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • x_splunkbase_authorization (str) – The splunkbase sessionID (required)

  • acs_licensing_ack (str) – ACS-Licensing-Ack is required for updating splunkbase apps (required)

  • version (str)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.apps_victoria_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.apps_victoria_api.AppsVictoriaApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

describe_app_victoria(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → App

get an app

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_app_victoria_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[App]

describe_app_victoria

get an app

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_app_victoria_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_app_victoria

get an app

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

download_app_export_victoria(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], default: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='export the default configs for the app etc/apps/<app_id>/default/*')] = None, local: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='export the local configs for the app under etc/apps/<app_id>/local/*')] = None, users: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='export the configs and data under etc/users/*/<app_id>/* for the users on which the requester has access over')] = None, confs_only: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='export only the configs as per request parameters and don’t export any app data')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → App

fetch the app data and returns the selected contents as a tar file

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • default (bool) – export the default configs for the app etc/apps/<app_id>/default/*

  • local (bool) – export the local configs for the app under etc/apps/<app_id>/local/*

  • users (bool) – export the configs and data under etc/users//<app_id>/ for the users on which the requester has access over

  • confs_only (bool) – export only the configs as per request parameters and don’t export any app data

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

download_app_export_victoria_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], default: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='export the default configs for the app etc/apps/<app_id>/default/*')] = None, local: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='export the local configs for the app under etc/apps/<app_id>/local/*')] = None, users: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='export the configs and data under etc/users/*/<app_id>/* for the users on which the requester has access over')] = None, confs_only: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='export only the configs as per request parameters and don’t export any app data')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[App]

download_app_export_victoria

fetch the app data and returns the selected contents as a tar file

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • default (bool) – export the default configs for the app etc/apps/<app_id>/default/*

  • local (bool) – export the local configs for the app under etc/apps/<app_id>/local/*

  • users (bool) – export the configs and data under etc/users//<app_id>/ for the users on which the requester has access over

  • confs_only (bool) – export only the configs as per request parameters and don’t export any app data

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

download_app_export_victoria_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], default: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='export the default configs for the app etc/apps/<app_id>/default/*')] = None, local: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='export the local configs for the app under etc/apps/<app_id>/local/*')] = None, users: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='export the configs and data under etc/users/*/<app_id>/* for the users on which the requester has access over')] = None, confs_only: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='export only the configs as per request parameters and don’t export any app data')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

download_app_export_victoria

fetch the app data and returns the selected contents as a tar file

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • default (bool) – export the default configs for the app etc/apps/<app_id>/default/*

  • local (bool) – export the local configs for the app under etc/apps/<app_id>/local/*

  • users (bool) – export the configs and data under etc/users//<app_id>/ for the users on which the requester has access over

  • confs_only (bool) – export only the configs as per request parameters and don’t export any app data

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

install_app_victoria(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], splunkbase: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='is the app available in splunkbase')] = None, x_splunkbase_authorization: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Splunkbase sessionID')] = None, x_splunk_authorization: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The app inspect token')] = None, acs_legal_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='ACS-Legal-Ack is required for installing private apps')] = None, acs_licensing_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='ACS-Licensing-Ack is required for installing splunkbase apps')] = None, splunkbase_id: Annotated[str, Strict(strict=True)] | None = None, version: Annotated[str, Strict(strict=True)] | None = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → App

install an app for Victoria stack

Parameters:

  • stack (str) – the stack name (required)

  • splunkbase (bool) – is the app available in splunkbase

  • x_splunkbase_authorization (str) – Splunkbase sessionID

  • x_splunk_authorization (str) – The app inspect token

  • acs_legal_ack (str) – ACS-Legal-Ack is required for installing private apps

  • acs_licensing_ack (str) – ACS-Licensing-Ack is required for installing splunkbase apps

  • splunkbase_id (str)

  • version (str)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

install_app_victoria_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], splunkbase: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='is the app available in splunkbase')] = None, x_splunkbase_authorization: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Splunkbase sessionID')] = None, x_splunk_authorization: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The app inspect token')] = None, acs_legal_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='ACS-Legal-Ack is required for installing private apps')] = None, acs_licensing_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='ACS-Licensing-Ack is required for installing splunkbase apps')] = None, splunkbase_id: Annotated[str, Strict(strict=True)] | None = None, version: Annotated[str, Strict(strict=True)] | None = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[App]

install_app_victoria

install an app for Victoria stack

Parameters:

  • stack (str) – the stack name (required)

  • splunkbase (bool) – is the app available in splunkbase

  • x_splunkbase_authorization (str) – Splunkbase sessionID

  • x_splunk_authorization (str) – The app inspect token

  • acs_legal_ack (str) – ACS-Legal-Ack is required for installing private apps

  • acs_licensing_ack (str) – ACS-Licensing-Ack is required for installing splunkbase apps

  • splunkbase_id (str)

  • version (str)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

install_app_victoria_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], splunkbase: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='is the app available in splunkbase')] = None, x_splunkbase_authorization: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Splunkbase sessionID')] = None, x_splunk_authorization: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The app inspect token')] = None, acs_legal_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='ACS-Legal-Ack is required for installing private apps')] = None, acs_licensing_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='ACS-Licensing-Ack is required for installing splunkbase apps')] = None, splunkbase_id: Annotated[str, Strict(strict=True)] | None = None, version: Annotated[str, Strict(strict=True)] | None = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

install_app_victoria

install an app for Victoria stack

Parameters:

  • stack (str) – the stack name (required)

  • splunkbase (bool) – is the app available in splunkbase

  • x_splunkbase_authorization (str) – Splunkbase sessionID

  • x_splunk_authorization (str) – The app inspect token

  • acs_legal_ack (str) – ACS-Legal-Ack is required for installing private apps

  • acs_licensing_ack (str) – ACS-Licensing-Ack is required for installing splunkbase apps

  • splunkbase_id (str)

  • version (str)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_apps_victoria(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, splunkbase: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='filter apps based on splunkbase and non-splunkbase apps')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ListApps200Response

list apps available on the stacks

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • splunkbase (bool) – filter apps based on splunkbase and non-splunkbase apps

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_apps_victoria_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, splunkbase: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='filter apps based on splunkbase and non-splunkbase apps')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[ListApps200Response]

list_apps_victoria

list apps available on the stacks

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • splunkbase (bool) – filter apps based on splunkbase and non-splunkbase apps

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_apps_victoria_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, splunkbase: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='filter apps based on splunkbase and non-splunkbase apps')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_apps_victoria

list apps available on the stacks

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • splunkbase (bool) – filter apps based on splunkbase and non-splunkbase apps

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_app_victoria(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], x_splunkbase_authorization: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The splunkbase sessionID')], acs_licensing_ack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='ACS-Licensing-Ack is required for updating splunkbase apps')], version: Annotated[str, Strict(strict=True)] | None = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → App

update an installed splunkbase apps

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • x_splunkbase_authorization (str) – The splunkbase sessionID (required)

  • acs_licensing_ack (str) – ACS-Licensing-Ack is required for updating splunkbase apps (required)

  • version (str)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_app_victoria_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], x_splunkbase_authorization: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The splunkbase sessionID')], acs_licensing_ack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='ACS-Licensing-Ack is required for updating splunkbase apps')], version: Annotated[str, Strict(strict=True)] | None = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[App]

patch_app_victoria

update an installed splunkbase apps

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • x_splunkbase_authorization (str) – The splunkbase sessionID (required)

  • acs_licensing_ack (str) – ACS-Licensing-Ack is required for updating splunkbase apps (required)

  • version (str)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_app_victoria_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], x_splunkbase_authorization: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The splunkbase sessionID')], acs_licensing_ack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='ACS-Licensing-Ack is required for updating splunkbase apps')], version: Annotated[str, Strict(strict=True)] | None = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

patch_app_victoria

update an installed splunkbase apps

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • x_splunkbase_authorization (str) – The splunkbase sessionID (required)

  • acs_licensing_ack (str) – ACS-Licensing-Ack is required for updating splunkbase apps (required)

  • version (str)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

uninstall_app_victoria(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

uninstall the app

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

uninstall_app_victoria_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

uninstall_app_victoria

uninstall the app

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

uninstall_app_victoria_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

uninstall_app_victoria

uninstall the app

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.capabilities_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.capabilities_api.CapabilitiesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

list_capabilities(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], grantable_only: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='only show grantable capabilities')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → CapabilitiesInfo

list capabilities

Parameters:

  • stack (str) – the stack name (required)

  • grantable_only (bool) – only show grantable capabilities

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_capabilities_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], grantable_only: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='only show grantable capabilities')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[CapabilitiesInfo]

list_capabilities

list capabilities

Parameters:

  • stack (str) – the stack name (required)

  • grantable_only (bool) – only show grantable capabilities

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_capabilities_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], grantable_only: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='only show grantable capabilities')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_capabilities

list capabilities

Parameters:

  • stack (str) – the stack name (required)

  • grantable_only (bool) – only show grantable capabilities

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.cloud_resources_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.cloud_resources_api.CloudResourcesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_self_storage_location(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], self_storage_location_body: Annotated[SelfStorageLocationBody, FieldInfo(annotation=NoneType, required=True, description='Self Storage Location Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → SelfStorageLocationInfo

Create self storage location on the stack

Parameters:

  • stack (str) – the stack name (required)

  • self_storage_location_body (SelfStorageLocationBody) – Self Storage Location Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_self_storage_location_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], self_storage_location_body: Annotated[SelfStorageLocationBody, FieldInfo(annotation=NoneType, required=True, description='Self Storage Location Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[SelfStorageLocationInfo]

create_self_storage_location

Create self storage location on the stack

Parameters:

  • stack (str) – the stack name (required)

  • self_storage_location_body (SelfStorageLocationBody) – Self Storage Location Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_self_storage_location_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], self_storage_location_body: Annotated[SelfStorageLocationBody, FieldInfo(annotation=NoneType, required=True, description='Self Storage Location Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

create_self_storage_location

Create self storage location on the stack

Parameters:

  • stack (str) – the stack name (required)

  • self_storage_location_body (SelfStorageLocationBody) – Self Storage Location Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_managed_glue_resources(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → DescribeManagedGlueResources

Describe cloud resources managed resources

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_managed_glue_resources_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[DescribeManagedGlueResources]

describe_managed_glue_resources

Describe cloud resources managed resources

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_managed_glue_resources_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_managed_glue_resources

Describe cloud resources managed resources

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_self_storage_location(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], bucket_path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='bucket path of the self storage location')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → SelfStorageLocationInfo

Describe a configured self storage location on the stack

Parameters:

  • stack (str) – the stack name (required)

  • bucket_path (str) – bucket path of the self storage location (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_self_storage_location_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], bucket_path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='bucket path of the self storage location')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[SelfStorageLocationInfo]

describe_self_storage_location

Describe a configured self storage location on the stack

Parameters:

  • stack (str) – the stack name (required)

  • bucket_path (str) – bucket path of the self storage location (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_self_storage_location_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], bucket_path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='bucket path of the self storage location')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_self_storage_location

Describe a configured self storage location on the stack

Parameters:

  • stack (str) – the stack name (required)

  • bucket_path (str) – bucket path of the self storage location (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_policy(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], bucket_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='bucket for self storage location')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → SelfStorageLocationPolicy

Get the IAM policy to configure S3 bucket for self storage location

Parameters:

  • stack (str) – the stack name (required)

  • bucket_name (str) – bucket for self storage location (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_policy_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], bucket_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='bucket for self storage location')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[SelfStorageLocationPolicy]

get_self_storage_location_policy

Get the IAM policy to configure S3 bucket for self storage location

Parameters:

  • stack (str) – the stack name (required)

  • bucket_name (str) – bucket for self storage location (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_policy_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], bucket_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='bucket for self storage location')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_self_storage_location_policy

Get the IAM policy to configure S3 bucket for self storage location

Parameters:

  • stack (str) – the stack name (required)

  • bucket_name (str) – bucket for self storage location (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_prefix(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → SelfStorageLocationPrefix

Get the bucket prefix required to configure self storage location(s)

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_prefix_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[SelfStorageLocationPrefix]

get_self_storage_location_prefix

Get the bucket prefix required to configure self storage location(s)

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_prefix_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_self_storage_location_prefix

Get the bucket prefix required to configure self storage location(s)

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_service_accounts(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → SelfStorageLocationServiceAccountsResponse

Get the service account for GCS bucket required to configure self storage location(s)

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_service_accounts_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[SelfStorageLocationServiceAccountsResponse]

get_self_storage_location_service_accounts

Get the service account for GCS bucket required to configure self storage location(s)

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_service_accounts_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_self_storage_location_service_accounts

Get the service account for GCS bucket required to configure self storage location(s)

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_self_storage_locations(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ListSelfStorageLocations200Response

List all configured self storage locations on the stack

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_self_storage_locations_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[ListSelfStorageLocations200Response]

list_self_storage_locations

List all configured self storage locations on the stack

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_self_storage_locations_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_self_storage_locations

List all configured self storage locations on the stack

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_managed_glue_resources(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], update_managed_glue_resources: Annotated[UpdateManagedGlueResources, FieldInfo(annotation=NoneType, required=True, description='The Federated Providers that will have their permissions updated')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → str

add cloud resource permissions for a set of federated providers

Parameters:

  • stack (str) – the stack name (required)

  • update_managed_glue_resources (UpdateManagedGlueResources) – The Federated Providers that will have their permissions updated (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_managed_glue_resources_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], update_managed_glue_resources: Annotated[UpdateManagedGlueResources, FieldInfo(annotation=NoneType, required=True, description='The Federated Providers that will have their permissions updated')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[str]

update_managed_glue_resources

add cloud resource permissions for a set of federated providers

Parameters:

  • stack (str) – the stack name (required)

  • update_managed_glue_resources (UpdateManagedGlueResources) – The Federated Providers that will have their permissions updated (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_managed_glue_resources_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], update_managed_glue_resources: Annotated[UpdateManagedGlueResources, FieldInfo(annotation=NoneType, required=True, description='The Federated Providers that will have their permissions updated')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

update_managed_glue_resources

add cloud resource permissions for a set of federated providers

Parameters:

  • stack (str) – the stack name (required)

  • update_managed_glue_resources (UpdateManagedGlueResources) – The Federated Providers that will have their permissions updated (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.ddss_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.ddss_api.DDSSApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_self_storage_location(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], self_storage_location_body: Annotated[SelfStorageLocationBody, FieldInfo(annotation=NoneType, required=True, description='Self Storage Location Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → SelfStorageLocationInfo

Create self storage location on the stack

Parameters:

  • stack (str) – the stack name (required)

  • self_storage_location_body (SelfStorageLocationBody) – Self Storage Location Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_self_storage_location_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], self_storage_location_body: Annotated[SelfStorageLocationBody, FieldInfo(annotation=NoneType, required=True, description='Self Storage Location Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[SelfStorageLocationInfo]

create_self_storage_location

Create self storage location on the stack

Parameters:

  • stack (str) – the stack name (required)

  • self_storage_location_body (SelfStorageLocationBody) – Self Storage Location Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_self_storage_location_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], self_storage_location_body: Annotated[SelfStorageLocationBody, FieldInfo(annotation=NoneType, required=True, description='Self Storage Location Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

create_self_storage_location

Create self storage location on the stack

Parameters:

  • stack (str) – the stack name (required)

  • self_storage_location_body (SelfStorageLocationBody) – Self Storage Location Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_self_storage_location(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], bucket_path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='bucket path of the self storage location')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → SelfStorageLocationInfo

Describe a configured self storage location on the stack

Parameters:

  • stack (str) – the stack name (required)

  • bucket_path (str) – bucket path of the self storage location (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_self_storage_location_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], bucket_path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='bucket path of the self storage location')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[SelfStorageLocationInfo]

describe_self_storage_location

Describe a configured self storage location on the stack

Parameters:

  • stack (str) – the stack name (required)

  • bucket_path (str) – bucket path of the self storage location (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_self_storage_location_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], bucket_path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='bucket path of the self storage location')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_self_storage_location

Describe a configured self storage location on the stack

Parameters:

  • stack (str) – the stack name (required)

  • bucket_path (str) – bucket path of the self storage location (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_policy(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], bucket_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='bucket for self storage location')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → SelfStorageLocationPolicy

Get the IAM policy to configure S3 bucket for self storage location

Parameters:

  • stack (str) – the stack name (required)

  • bucket_name (str) – bucket for self storage location (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_policy_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], bucket_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='bucket for self storage location')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[SelfStorageLocationPolicy]

get_self_storage_location_policy

Get the IAM policy to configure S3 bucket for self storage location

Parameters:

  • stack (str) – the stack name (required)

  • bucket_name (str) – bucket for self storage location (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_policy_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], bucket_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='bucket for self storage location')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_self_storage_location_policy

Get the IAM policy to configure S3 bucket for self storage location

Parameters:

  • stack (str) – the stack name (required)

  • bucket_name (str) – bucket for self storage location (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_prefix(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → SelfStorageLocationPrefix

Get the bucket prefix required to configure self storage location(s)

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_prefix_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[SelfStorageLocationPrefix]

get_self_storage_location_prefix

Get the bucket prefix required to configure self storage location(s)

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_prefix_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_self_storage_location_prefix

Get the bucket prefix required to configure self storage location(s)

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_service_accounts(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → SelfStorageLocationServiceAccountsResponse

Get the service account for GCS bucket required to configure self storage location(s)

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_service_accounts_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[SelfStorageLocationServiceAccountsResponse]

get_self_storage_location_service_accounts

Get the service account for GCS bucket required to configure self storage location(s)

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_self_storage_location_service_accounts_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_self_storage_location_service_accounts

Get the service account for GCS bucket required to configure self storage location(s)

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_self_storage_locations(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ListSelfStorageLocations200Response

List all configured self storage locations on the stack

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_self_storage_locations_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[ListSelfStorageLocations200Response]

list_self_storage_locations

List all configured self storage locations on the stack

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_self_storage_locations_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_self_storage_locations

List all configured self storage locations on the stack

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.default_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.default_api.DefaultApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_hec(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec_spec: Annotated[HecSpec, FieldInfo(annotation=NoneType, required=True, description='Hec Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → CreateHEC202Response

Create hec token for the stack

Parameters:

  • stack (str) – the stack name (required)

  • hec_spec (HecSpec) – Hec Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_hec_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec_spec: Annotated[HecSpec, FieldInfo(annotation=NoneType, required=True, description='Hec Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[CreateHEC202Response]

create_hec

Create hec token for the stack

Parameters:

  • stack (str) – the stack name (required)

  • hec_spec (HecSpec) – Hec Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_hec_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec_spec: Annotated[HecSpec, FieldInfo(annotation=NoneType, required=True, description='Hec Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

create_hec

Create hec token for the stack

Parameters:

  • stack (str) – the stack name (required)

  • hec_spec (HecSpec) – Hec Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_hec(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='hec name')], body: Annotated[Dict[str, Any], FieldInfo(annotation=NoneType, required=True, description='Name of the HEC Object to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → str

delete HEC

Parameters:

  • stack (str) – the stack name (required)

  • hec (str) – hec name (required)

  • body (object) – Name of the HEC Object to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_hec_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='hec name')], body: Annotated[Dict[str, Any], FieldInfo(annotation=NoneType, required=True, description='Name of the HEC Object to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[str]

delete_hec

delete HEC

Parameters:

  • stack (str) – the stack name (required)

  • hec (str) – hec name (required)

  • body (object) – Name of the HEC Object to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_hec_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='hec name')], body: Annotated[Dict[str, Any], FieldInfo(annotation=NoneType, required=True, description='Name of the HEC Object to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_hec

delete HEC

Parameters:

  • stack (str) – the stack name (required)

  • hec (str) – hec name (required)

  • body (object) – Name of the HEC Object to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_hec(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='hec name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → DescribeHec200Response

Get detailed Info about a particular HEC

Parameters:

  • stack (str) – the stack name (required)

  • hec (str) – hec name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_hec_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='hec name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[DescribeHec200Response]

describe_hec

Get detailed Info about a particular HEC

Parameters:

  • stack (str) – the stack name (required)

  • hec (str) – hec name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_hec_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='hec name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_hec

Get detailed Info about a particular HEC

Parameters:

  • stack (str) – the stack name (required)

  • hec (str) – hec name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_hecs(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ListHECs200Response

List of all HEC objects

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_hecs_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[ListHECs200Response]

list_hecs

List of all HEC objects

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_hecs_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_hecs

List of all HEC objects

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_hec(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='hec name')], hec_spec: Annotated[HecSpec, FieldInfo(annotation=NoneType, required=True, description='Modify Hec object')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → str

Modify properties of HEC

Parameters:

  • stack (str) – the stack name (required)

  • hec (str) – hec name (required)

  • hec_spec (HecSpec) – Modify Hec object (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_hec_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='hec name')], hec_spec: Annotated[HecSpec, FieldInfo(annotation=NoneType, required=True, description='Modify Hec object')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[str]

patch_hec

Modify properties of HEC

Parameters:

  • stack (str) – the stack name (required)

  • hec (str) – hec name (required)

  • hec_spec (HecSpec) – Modify Hec object (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_hec_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='hec name')], hec_spec: Annotated[HecSpec, FieldInfo(annotation=NoneType, required=True, description='Modify Hec object')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

patch_hec

Modify properties of HEC

Parameters:

  • stack (str) – the stack name (required)

  • hec (str) – hec name (required)

  • hec_spec (HecSpec) – Modify Hec object (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_hec(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='hec name')], hec_spec: Annotated[HecSpec, FieldInfo(annotation=NoneType, required=True, description='Modify Hec object')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → str

Modify properties of HEC

Parameters:

  • stack (str) – the stack name (required)

  • hec (str) – hec name (required)

  • hec_spec (HecSpec) – Modify Hec object (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_hec_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='hec name')], hec_spec: Annotated[HecSpec, FieldInfo(annotation=NoneType, required=True, description='Modify Hec object')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[str]

update_hec

Modify properties of HEC

Parameters:

  • stack (str) – the stack name (required)

  • hec (str) – hec name (required)

  • hec_spec (HecSpec) – Modify Hec object (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_hec_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], hec: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='hec name')], hec_spec: Annotated[HecSpec, FieldInfo(annotation=NoneType, required=True, description='Modify Hec object')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

update_hec

Modify properties of HEC

Parameters:

  • stack (str) – the stack name (required)

  • hec (str) – hec name (required)

  • hec_spec (HecSpec) – Modify Hec object (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.emek_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.emek_api.EMEKApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

describe_emek_waiver(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → str

Generate legal waiver for EMEK

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_emek_waiver_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[str]

describe_emek_waiver

Generate legal waiver for EMEK

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_emek_waiver_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_emek_waiver

Generate legal waiver for EMEK

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_emek_policy(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], emek_legal_ack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='EMEK-Legal-Ack is required for generating key policy')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → EmekPolicy

Generate the key policy for EMEK

Parameters:

  • stack (str) – the stack name (required)

  • emek_legal_ack (str) – EMEK-Legal-Ack is required for generating key policy (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_emek_policy_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], emek_legal_ack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='EMEK-Legal-Ack is required for generating key policy')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[EmekPolicy]

get_emek_policy

Generate the key policy for EMEK

Parameters:

  • stack (str) – the stack name (required)

  • emek_legal_ack (str) – EMEK-Legal-Ack is required for generating key policy (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_emek_policy_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], emek_legal_ack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='EMEK-Legal-Ack is required for generating key policy')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_emek_policy

Generate the key policy for EMEK

Parameters:

  • stack (str) – the stack name (required)

  • emek_legal_ack (str) – EMEK-Legal-Ack is required for generating key policy (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

put_emek_key(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], put_emek_key_request: Annotated[PutEmekKeyRequest | None, FieldInfo(annotation=NoneType, required=True, description='Key ARN to be uploaded')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → EmekKeyUploadResponse

EMEK Key upload

Parameters:

  • stack (str) – the stack name (required)

  • put_emek_key_request (PutEmekKeyRequest) – Key ARN to be uploaded

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

put_emek_key_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], put_emek_key_request: Annotated[PutEmekKeyRequest | None, FieldInfo(annotation=NoneType, required=True, description='Key ARN to be uploaded')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[EmekKeyUploadResponse]

put_emek_key

EMEK Key upload

Parameters:

  • stack (str) – the stack name (required)

  • put_emek_key_request (PutEmekKeyRequest) – Key ARN to be uploaded

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

put_emek_key_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], put_emek_key_request: Annotated[PutEmekKeyRequest | None, FieldInfo(annotation=NoneType, required=True, description='Key ARN to be uploaded')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

put_emek_key

EMEK Key upload

Parameters:

  • stack (str) – the stack name (required)

  • put_emek_key_request (PutEmekKeyRequest) – Key ARN to be uploaded

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.enablement_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.enablement_api.EnablementApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

describe_app_feature_enablement(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app_group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], feature_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → AppFeatureEnablement

describe the enablement status of an app feature

Parameters:

  • stack (str) – the stack name (required)

  • app_group (str) – the app name (required)

  • feature_name (str) – the feature name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_app_feature_enablement_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app_group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], feature_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[AppFeatureEnablement]

describe_app_feature_enablement

describe the enablement status of an app feature

Parameters:

  • stack (str) – the stack name (required)

  • app_group (str) – the app name (required)

  • feature_name (str) – the feature name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_app_feature_enablement_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app_group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], feature_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_app_feature_enablement

describe the enablement status of an app feature

Parameters:

  • stack (str) – the stack name (required)

  • app_group (str) – the app name (required)

  • feature_name (str) – the feature name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

set_app_feature_enablement(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app_group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], feature_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature name')], app_feature_enablement: Annotated[AppFeatureEnablement, FieldInfo(annotation=NoneType, required=True, description='enablement')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → AppFeatureEnablement

Enable or disable an app feature

Parameters:

  • stack (str) – the stack name (required)

  • app_group (str) – the app name (required)

  • feature_name (str) – the feature name (required)

  • app_feature_enablement (AppFeatureEnablement) – enablement (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

set_app_feature_enablement_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app_group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], feature_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature name')], app_feature_enablement: Annotated[AppFeatureEnablement, FieldInfo(annotation=NoneType, required=True, description='enablement')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[AppFeatureEnablement]

set_app_feature_enablement

Enable or disable an app feature

Parameters:

  • stack (str) – the stack name (required)

  • app_group (str) – the app name (required)

  • feature_name (str) – the feature name (required)

  • app_feature_enablement (AppFeatureEnablement) – enablement (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

set_app_feature_enablement_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app_group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], feature_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature name')], app_feature_enablement: Annotated[AppFeatureEnablement, FieldInfo(annotation=NoneType, required=True, description='enablement')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

set_app_feature_enablement

Enable or disable an app feature

Parameters:

  • stack (str) – the stack name (required)

  • app_group (str) – the app name (required)

  • feature_name (str) – the feature name (required)

  • app_feature_enablement (AppFeatureEnablement) – enablement (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.indexes_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.indexes_api.IndexesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_index(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], index_info: Annotated[IndexInfo, FieldInfo(annotation=NoneType, required=True, description='Index Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → IndexInfo

create index on the stack

Parameters:

  • stack (str) – the stack name (required)

  • index_info (IndexInfo) – Index Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_index_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], index_info: Annotated[IndexInfo, FieldInfo(annotation=NoneType, required=True, description='Index Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[IndexInfo]

create_index

create index on the stack

Parameters:

  • stack (str) – the stack name (required)

  • index_info (IndexInfo) – Index Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_index_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], index_info: Annotated[IndexInfo, FieldInfo(annotation=NoneType, required=True, description='Index Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

create_index

create index on the stack

Parameters:

  • stack (str) – the stack name (required)

  • index_info (IndexInfo) – Index Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_index(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], index: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='index name')], body: Annotated[Dict[str, Any], FieldInfo(annotation=NoneType, required=True, description='Name of the index object to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

Delete index on the stack

Parameters:

  • stack (str) – the stack name (required)

  • index (str) – index name (required)

  • body (object) – Name of the index object to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_index_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], index: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='index name')], body: Annotated[Dict[str, Any], FieldInfo(annotation=NoneType, required=True, description='Name of the index object to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

delete_index

Delete index on the stack

Parameters:

  • stack (str) – the stack name (required)

  • index (str) – index name (required)

  • body (object) – Name of the index object to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_index_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], index: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='index name')], body: Annotated[Dict[str, Any], FieldInfo(annotation=NoneType, required=True, description='Name of the index object to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_index

Delete index on the stack

Parameters:

  • stack (str) – the stack name (required)

  • index (str) – index name (required)

  • body (object) – Name of the index object to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_index_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], index: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='index name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → GetIndexInfo200Response

get index info on the stack

Parameters:

  • stack (str) – the stack name (required)

  • index (str) – index name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_index_info_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], index: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='index name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[GetIndexInfo200Response]

get_index_info

get index info on the stack

Parameters:

  • stack (str) – the stack name (required)

  • index (str) – index name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_index_info_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], index: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='index name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_index_info

get index info on the stack

Parameters:

  • stack (str) – the stack name (required)

  • index (str) – index name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_indexes(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ListIndexes200Response

list all indexes available on the stack

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_indexes_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[ListIndexes200Response]

list_indexes

list all indexes available on the stack

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_indexes_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_indexes

list all indexes available on the stack

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_index_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], index: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='index name')], patch_index_info: Annotated[PatchIndexInfo, FieldInfo(annotation=NoneType, required=True, description='Modify index object info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

Modify index info on the stack

Parameters:

  • stack (str) – the stack name (required)

  • index (str) – index name (required)

  • patch_index_info (PatchIndexInfo) – Modify index object info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_index_info_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], index: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='index name')], patch_index_info: Annotated[PatchIndexInfo, FieldInfo(annotation=NoneType, required=True, description='Modify index object info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

patch_index_info

Modify index info on the stack

Parameters:

  • stack (str) – the stack name (required)

  • index (str) – index name (required)

  • patch_index_info (PatchIndexInfo) – Modify index object info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_index_info_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], index: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='index name')], patch_index_info: Annotated[PatchIndexInfo, FieldInfo(annotation=NoneType, required=True, description='Modify index object info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

patch_index_info

Modify index info on the stack

Parameters:

  • stack (str) – the stack name (required)

  • index (str) – index name (required)

  • patch_index_info (PatchIndexInfo) – Modify index object info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.ipv6_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.ipv6_api.Ipv6Api(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_allowlist_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the new subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → WarningResponse

add ipv6 subnets to the allowlist for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the new subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_allowlist_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the new subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[WarningResponse]

create_allowlist_v6

add ipv6 subnets to the allowlist for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the new subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_allowlist_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the new subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

create_allowlist_v6

add ipv6 subnets to the allowlist for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the new subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_outbound_ports_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], create_outbound_ports_v6_request: Annotated[CreateOutboundPortsV6Request, FieldInfo(annotation=NoneType, required=True, description='the new ipv6 subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → WarningResponse

add ipv6 subnets to the outboundports for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • create_outbound_ports_v6_request (CreateOutboundPortsV6Request) – the new ipv6 subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_outbound_ports_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], create_outbound_ports_v6_request: Annotated[CreateOutboundPortsV6Request, FieldInfo(annotation=NoneType, required=True, description='the new ipv6 subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[WarningResponse]

create_outbound_ports_v6

add ipv6 subnets to the outboundports for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • create_outbound_ports_v6_request (CreateOutboundPortsV6Request) – the new ipv6 subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_outbound_ports_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], create_outbound_ports_v6_request: Annotated[CreateOutboundPortsV6Request, FieldInfo(annotation=NoneType, required=True, description='the new ipv6 subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

create_outbound_ports_v6

add ipv6 subnets to the outboundports for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • create_outbound_ports_v6_request (CreateOutboundPortsV6Request) – the new ipv6 subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_allowlist_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], subnet: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnet to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → WarningResponse

delete an existing ipv6 subnet if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • subnet (str) – the ipv6 subnet to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_allowlist_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], subnet: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnet to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[WarningResponse]

delete_allowlist_v6

delete an existing ipv6 subnet if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • subnet (str) – the ipv6 subnet to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_allowlist_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], subnet: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnet to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_allowlist_v6

delete an existing ipv6 subnet if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • subnet (str) – the ipv6 subnet to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_allowlists_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnets to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → WarningResponse

delete existing ipv6 subnets (if they exists) from where the splunk cloud stack feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the ipv6 subnets to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_allowlists_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnets to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[WarningResponse]

delete_allowlists_v6

delete existing ipv6 subnets (if they exists) from where the splunk cloud stack feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the ipv6 subnets to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_allowlists_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnets to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_allowlists_v6

delete existing ipv6 subnets (if they exists) from where the splunk cloud stack feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the ipv6 subnets to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_outbound_port_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the ipv6 outbound port to be deleted')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnets to delete outbound ports for')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

delete an existing ipv6 outbound port if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the ipv6 outbound port to be deleted (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the ipv6 subnets to delete outbound ports for (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_outbound_port_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the ipv6 outbound port to be deleted')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnets to delete outbound ports for')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

delete_outbound_port_v6

delete an existing ipv6 outbound port if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the ipv6 outbound port to be deleted (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the ipv6 subnets to delete outbound ports for (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_outbound_port_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the ipv6 outbound port to be deleted')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnets to delete outbound ports for')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_outbound_port_v6

delete an existing ipv6 outbound port if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the ipv6 outbound port to be deleted (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the ipv6 subnets to delete outbound ports for (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_allowlist_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → DescribeAllowlistV6200Response

describe the allowlist with its status and ipv6 subnets from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_allowlist_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[DescribeAllowlistV6200Response]

describe_allowlist_v6

describe the allowlist with its status and ipv6 subnets from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_allowlist_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the feature the access rules apply towards')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_allowlist_v6

describe the allowlist with its status and ipv6 subnets from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – the feature the access rules apply towards (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_outboundports_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the port on which we want to get the allowed ipv6 subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → List[OutboundResponse]

describe the outboundports with ports and ipv6 subnets

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the port on which we want to get the allowed ipv6 subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_outboundports_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the port on which we want to get the allowed ipv6 subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[List[splunk_acs_sdk.models.outbound_response.OutboundResponse]]

describe_outboundports_v6

describe the outboundports with ports and ipv6 subnets

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the port on which we want to get the allowed ipv6 subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_outboundports_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the port on which we want to get the allowed ipv6 subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_outboundports_v6

describe the outboundports with ports and ipv6 subnets

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the port on which we want to get the allowed ipv6 subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_outbound_ports_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → List[OutboundResponse]

list the outboundports with ports and ipv6 subnets

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_outbound_ports_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[List[splunk_acs_sdk.models.outbound_response.OutboundResponse]]

list_outbound_ports_v6

list the outboundports with ports and ipv6 subnets

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_outbound_ports_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_outbound_ports_v6

list the outboundports with ports and ipv6 subnets

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.limits_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.limits_api.LimitsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

add_limit_config(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], limit_configuration_info: Annotated[LimitConfigurationInfo, FieldInfo(annotation=NoneType, required=True, description='Limit Setting Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → str

add limit configuration to the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • limit_configuration_info (LimitConfigurationInfo) – Limit Setting Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

add_limit_config_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], limit_configuration_info: Annotated[LimitConfigurationInfo, FieldInfo(annotation=NoneType, required=True, description='Limit Setting Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[str]

add_limit_config

add limit configuration to the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • limit_configuration_info (LimitConfigurationInfo) – Limit Setting Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

add_limit_config_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], limit_configuration_info: Annotated[LimitConfigurationInfo, FieldInfo(annotation=NoneType, required=True, description='Limit Setting Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

add_limit_config

add limit configuration to the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • limit_configuration_info (LimitConfigurationInfo) – Limit Setting Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_all_limits_config(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

get all limits configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_all_limits_config_defaults(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → List[LimitStanza]

get default, minimum and maximum values for all limits configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_all_limits_config_defaults_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[List[splunk_acs_sdk.models.limit_stanza.LimitStanza]]

get_all_limits_config_defaults

get default, minimum and maximum values for all limits configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_all_limits_config_defaults_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_all_limits_config_defaults

get default, minimum and maximum values for all limits configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_all_limits_config_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

get_all_limits_config

get all limits configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_all_limits_config_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_all_limits_config

get all limits configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_key_limit_config(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], key: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='key name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → GetLimitConfig200Response

get limit configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • key (str) – key name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_key_limit_config_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], key: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='key name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[GetLimitConfig200Response]

get_key_limit_config

get limit configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • key (str) – key name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_key_limit_config_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], key: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='key name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_key_limit_config

get limit configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • key (str) – key name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_limit_config(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → GetLimitConfig200Response

get limit configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_limit_config_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[GetLimitConfig200Response]

get_limit_config

get limit configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_limit_config_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_limit_config

get limit configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_limits_config_defaults(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → LimitStanza

get default, minimum, and maximum values for limit configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_limits_config_defaults_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[LimitStanza]

get_limits_config_defaults

get default, minimum, and maximum values for limit configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_limits_config_defaults_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_limits_config_defaults

get default, minimum, and maximum values for limit configuration from the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

reset_limit_config(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], limit_reset_settings_list: Annotated[LimitResetSettingsList, FieldInfo(annotation=NoneType, required=True, description='Limit Setting Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → str

reset limit configuration on the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • limit_reset_settings_list (LimitResetSettingsList) – Limit Setting Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

reset_limit_config_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], limit_reset_settings_list: Annotated[LimitResetSettingsList, FieldInfo(annotation=NoneType, required=True, description='Limit Setting Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[str]

reset_limit_config

reset limit configuration on the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • limit_reset_settings_list (LimitResetSettingsList) – Limit Setting Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

reset_limit_config_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], stanza: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='stanza name')], limit_reset_settings_list: Annotated[LimitResetSettingsList, FieldInfo(annotation=NoneType, required=True, description='Limit Setting Info')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

reset_limit_config

reset limit configuration on the stack

Parameters:

  • stack (str) – the stack name (required)

  • stanza (str) – stanza name (required)

  • limit_reset_settings_list (LimitResetSettingsList) – Limit Setting Info (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.maintenance_windows_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.maintenance_windows_api.MaintenanceWindowsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

audit_maintenance_windows_schedule(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], schedule_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The maintenance window schedule ID.')], from_time: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The earliest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.')] = None, to_time: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The latest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → List[MaintenanceWindowsAuditResponse]

Audit status changes for a specific maintenance window schedule.

Parameters:

  • stack (str) – the stack name (required)

  • schedule_id (str) – The maintenance window schedule ID. (required)

  • from_time (str) – The earliest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.

  • to_time (str) – The latest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

audit_maintenance_windows_schedule_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], schedule_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The maintenance window schedule ID.')], from_time: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The earliest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.')] = None, to_time: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The latest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[List[splunk_acs_sdk.models.maintenance_windows_audit_response.MaintenanceWindowsAuditResponse]]

audit_maintenance_windows_schedule

Audit status changes for a specific maintenance window schedule.

Parameters:

  • stack (str) – the stack name (required)

  • schedule_id (str) – The maintenance window schedule ID. (required)

  • from_time (str) – The earliest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.

  • to_time (str) – The latest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

audit_maintenance_windows_schedule_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], schedule_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The maintenance window schedule ID.')], from_time: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The earliest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.')] = None, to_time: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The latest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

audit_maintenance_windows_schedule

Audit status changes for a specific maintenance window schedule.

Parameters:

  • stack (str) – the stack name (required)

  • schedule_id (str) – The maintenance window schedule ID. (required)

  • from_time (str) – The earliest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.

  • to_time (str) – The latest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_maintenance_windows_preferences(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → MaintenanceWindowsPreferencesResponse

Describe maintenance window preferences for a stack.

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_maintenance_windows_preferences_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[MaintenanceWindowsPreferencesResponse]

describe_maintenance_windows_preferences

Describe maintenance window preferences for a stack.

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_maintenance_windows_preferences_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_maintenance_windows_preferences

Describe maintenance window preferences for a stack.

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_maintenance_windows_schedule(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], schedule_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The maintenance window schedule ID.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → MaintenanceWindowsSchedule

Describe a specific maintenance window schedule

Parameters:

  • stack (str) – the stack name (required)

  • schedule_id (str) – The maintenance window schedule ID. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_maintenance_windows_schedule_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], schedule_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The maintenance window schedule ID.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[MaintenanceWindowsSchedule]

describe_maintenance_windows_schedule

Describe a specific maintenance window schedule

Parameters:

  • stack (str) – the stack name (required)

  • schedule_id (str) – The maintenance window schedule ID. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_maintenance_windows_schedule_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], schedule_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The maintenance window schedule ID.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_maintenance_windows_schedule

Describe a specific maintenance window schedule

Parameters:

  • stack (str) – the stack name (required)

  • schedule_id (str) – The maintenance window schedule ID. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_maintenance_windows_schedules(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, next_link: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The key for the next page of the result set. A nextLink with the value null indicates there are no more pages.')] = None, from_time: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The earliest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.')] = None, to_time: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The latest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → List[MaintenanceWindowsResponse]

List all scheduled maintenance windows schedules on the stack. The default time range is 30 days. If both fromTime and toTime is empty, the default range is +30 days from current time. If only toTime is given, the default range is -30 days from toTime.

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • next_link (str) – The key for the next page of the result set. A nextLink with the value null indicates there are no more pages.

  • from_time (str) – The earliest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.

  • to_time (str) – The latest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_maintenance_windows_schedules_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, next_link: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The key for the next page of the result set. A nextLink with the value null indicates there are no more pages.')] = None, from_time: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The earliest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.')] = None, to_time: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The latest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[List[splunk_acs_sdk.models.maintenance_windows_response.MaintenanceWindowsResponse]]

list_maintenance_windows_schedules

List all scheduled maintenance windows schedules on the stack. The default time range is 30 days. If both fromTime and toTime is empty, the default range is +30 days from current time. If only toTime is given, the default range is -30 days from toTime.

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • next_link (str) – The key for the next page of the result set. A nextLink with the value null indicates there are no more pages.

  • from_time (str) – The earliest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.

  • to_time (str) – The latest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_maintenance_windows_schedules_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, next_link: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The key for the next page of the result set. A nextLink with the value null indicates there are no more pages.')] = None, from_time: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The earliest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.')] = None, to_time: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The latest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_maintenance_windows_schedules

List all scheduled maintenance windows schedules on the stack. The default time range is 30 days. If both fromTime and toTime is empty, the default range is +30 days from current time. If only toTime is given, the default range is -30 days from toTime.

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • next_link (str) – The key for the next page of the result set. A nextLink with the value null indicates there are no more pages.

  • from_time (str) – The earliest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.

  • to_time (str) – The latest time to return results from. Format is expected to be YYYY-MM-DD or in RFC3339. UTC is the default timezone.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_maintenance_windows_preferences(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], maintenance_windows_preferences_request: MaintenanceWindowsPreferencesRequest | None = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

Update maintenance window preferences for a stack.

Parameters:

  • stack (str) – the stack name (required)

  • maintenance_windows_preferences_request (MaintenanceWindowsPreferencesRequest)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_maintenance_windows_preferences_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], maintenance_windows_preferences_request: MaintenanceWindowsPreferencesRequest | None = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

update_maintenance_windows_preferences

Update maintenance window preferences for a stack.

Parameters:

  • stack (str) – the stack name (required)

  • maintenance_windows_preferences_request (MaintenanceWindowsPreferencesRequest)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_maintenance_windows_preferences_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], maintenance_windows_preferences_request: MaintenanceWindowsPreferencesRequest | None = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

update_maintenance_windows_preferences

Update maintenance window preferences for a stack.

Parameters:

  • stack (str) – the stack name (required)

  • maintenance_windows_preferences_request (MaintenanceWindowsPreferencesRequest)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.managed_glue_resources_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.managed_glue_resources_api.ManagedGlueResourcesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

describe_managed_glue_resources(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → DescribeManagedGlueResources

Describe cloud resources managed resources

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_managed_glue_resources_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[DescribeManagedGlueResources]

describe_managed_glue_resources

Describe cloud resources managed resources

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_managed_glue_resources_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_managed_glue_resources

Describe cloud resources managed resources

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_managed_glue_resources(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], update_managed_glue_resources: Annotated[UpdateManagedGlueResources, FieldInfo(annotation=NoneType, required=True, description='The Federated Providers that will have their permissions updated')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → str

add cloud resource permissions for a set of federated providers

Parameters:

  • stack (str) – the stack name (required)

  • update_managed_glue_resources (UpdateManagedGlueResources) – The Federated Providers that will have their permissions updated (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_managed_glue_resources_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], update_managed_glue_resources: Annotated[UpdateManagedGlueResources, FieldInfo(annotation=NoneType, required=True, description='The Federated Providers that will have their permissions updated')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[str]

update_managed_glue_resources

add cloud resource permissions for a set of federated providers

Parameters:

  • stack (str) – the stack name (required)

  • update_managed_glue_resources (UpdateManagedGlueResources) – The Federated Providers that will have their permissions updated (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_managed_glue_resources_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], update_managed_glue_resources: Annotated[UpdateManagedGlueResources, FieldInfo(annotation=NoneType, required=True, description='The Federated Providers that will have their permissions updated')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

update_managed_glue_resources

add cloud resource permissions for a set of federated providers

Parameters:

  • stack (str) – the stack name (required)

  • update_managed_glue_resources (UpdateManagedGlueResources) – The Federated Providers that will have their permissions updated (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.observability_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.observability_api.ObservabilityApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

enable_rbac_on_o11y(o11y_access_token: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Observability Admin Access Token')], stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The stack name.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

set the paired Splunk Cloud stack as the RBAC source for Splunk Observability Cloud organization

Parameters:

  • o11y_access_token (str) – Observability Admin Access Token (required)

  • stack (str) – The stack name. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

enable_rbac_on_o11y_with_http_info(o11y_access_token: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Observability Admin Access Token')], stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The stack name.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

enable_rbac_on_o11y

set the paired Splunk Cloud stack as the RBAC source for Splunk Observability Cloud organization

Parameters:

  • o11y_access_token (str) – Observability Admin Access Token (required)

  • stack (str) – The stack name. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

enable_rbac_on_o11y_without_preload_content(o11y_access_token: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Observability Admin Access Token')], stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The stack name.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

enable_rbac_on_o11y

set the paired Splunk Cloud stack as the RBAC source for Splunk Observability Cloud organization

Parameters:

  • o11y_access_token (str) – Observability Admin Access Token (required)

  • stack (str) – The stack name. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_observability_pairing_status(o11y_access_token: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Observability Admin Access Token')], stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The stack name.')], pairing_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='A pairing ID.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → GetEcSsoPairingStatusResponse

Gets a status for pairing your Splunk Cloud stack with the Observability cloud Org.

Parameters:

  • o11y_access_token (str) – Observability Admin Access Token (required)

  • stack (str) – The stack name. (required)

  • pairing_id (str) – A pairing ID. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_observability_pairing_status_with_http_info(o11y_access_token: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Observability Admin Access Token')], stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The stack name.')], pairing_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='A pairing ID.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[GetEcSsoPairingStatusResponse]

get_observability_pairing_status

Gets a status for pairing your Splunk Cloud stack with the Observability cloud Org.

Parameters:

  • o11y_access_token (str) – Observability Admin Access Token (required)

  • stack (str) – The stack name. (required)

  • pairing_id (str) – A pairing ID. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_observability_pairing_status_without_preload_content(o11y_access_token: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Observability Admin Access Token')], stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The stack name.')], pairing_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='A pairing ID.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_observability_pairing_status

Gets a status for pairing your Splunk Cloud stack with the Observability cloud Org.

Parameters:

  • o11y_access_token (str) – Observability Admin Access Token (required)

  • stack (str) – The stack name. (required)

  • pairing_id (str) – A pairing ID. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

post_observability_capabilities_on_splunk(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The stack name.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → EnableObservabilityCapabilitiesResponse

enables the o11y-splunk centralized RBAC integration including the addition of o11y roles and capabilities on the stack.

Parameters:

  • stack (str) – The stack name. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

post_observability_capabilities_on_splunk_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The stack name.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[EnableObservabilityCapabilitiesResponse]

post_observability_capabilities_on_splunk

enables the o11y-splunk centralized RBAC integration including the addition of o11y roles and capabilities on the stack.

Parameters:

  • stack (str) – The stack name. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

post_observability_capabilities_on_splunk_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The stack name.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

post_observability_capabilities_on_splunk

enables the o11y-splunk centralized RBAC integration including the addition of o11y roles and capabilities on the stack.

Parameters:

  • stack (str) – The stack name. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

post_observability_pairing(o11y_access_token: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Observability Admin Access Token')], stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The stack name.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → CreateEcSsoPairingResponse

Pair your Splunk Cloud stack to the Observability cloud org to use the stack as Identity Provider

Parameters:

  • o11y_access_token (str) – Observability Admin Access Token (required)

  • stack (str) – The stack name. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

post_observability_pairing_with_http_info(o11y_access_token: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Observability Admin Access Token')], stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The stack name.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[CreateEcSsoPairingResponse]

post_observability_pairing

Pair your Splunk Cloud stack to the Observability cloud org to use the stack as Identity Provider

Parameters:

  • o11y_access_token (str) – Observability Admin Access Token (required)

  • stack (str) – The stack name. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

post_observability_pairing_without_preload_content(o11y_access_token: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Observability Admin Access Token')], stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='The stack name.')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

post_observability_pairing

Pair your Splunk Cloud stack to the Observability cloud org to use the stack as Identity Provider

Parameters:

  • o11y_access_token (str) – Observability Admin Access Token (required)

  • stack (str) – The stack name. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.outbound_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.outbound_api.OutboundApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

add_outboundports(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], add_outboundports_request: Annotated[AddOutboundportsRequest, FieldInfo(annotation=NoneType, required=True, description='the new subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → WarningResponse

add subnets to the outboundports for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • add_outboundports_request (AddOutboundportsRequest) – the new subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

add_outboundports_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], add_outboundports_request: Annotated[AddOutboundportsRequest, FieldInfo(annotation=NoneType, required=True, description='the new subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[WarningResponse]

add_outboundports

add subnets to the outboundports for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • add_outboundports_request (AddOutboundportsRequest) – the new subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

add_outboundports_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], add_outboundports_request: Annotated[AddOutboundportsRequest, FieldInfo(annotation=NoneType, required=True, description='the new subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

add_outboundports

add subnets to the outboundports for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • add_outboundports_request (AddOutboundportsRequest) – the new subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_outbound_ports_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], create_outbound_ports_v6_request: Annotated[CreateOutboundPortsV6Request, FieldInfo(annotation=NoneType, required=True, description='the new ipv6 subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → WarningResponse

add ipv6 subnets to the outboundports for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • create_outbound_ports_v6_request (CreateOutboundPortsV6Request) – the new ipv6 subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_outbound_ports_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], create_outbound_ports_v6_request: Annotated[CreateOutboundPortsV6Request, FieldInfo(annotation=NoneType, required=True, description='the new ipv6 subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[WarningResponse]

create_outbound_ports_v6

add ipv6 subnets to the outboundports for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • create_outbound_ports_v6_request (CreateOutboundPortsV6Request) – the new ipv6 subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_outbound_ports_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], create_outbound_ports_v6_request: Annotated[CreateOutboundPortsV6Request, FieldInfo(annotation=NoneType, required=True, description='the new ipv6 subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

create_outbound_ports_v6

add ipv6 subnets to the outboundports for the feature, if they don’t already exist

Parameters:

  • stack (str) – the stack name (required)

  • create_outbound_ports_v6_request (CreateOutboundPortsV6Request) – the new ipv6 subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_outbound_port_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the ipv6 outbound port to be deleted')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnets to delete outbound ports for')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

delete an existing ipv6 outbound port if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the ipv6 outbound port to be deleted (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the ipv6 subnets to delete outbound ports for (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_outbound_port_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the ipv6 outbound port to be deleted')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnets to delete outbound ports for')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

delete_outbound_port_v6

delete an existing ipv6 outbound port if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the ipv6 outbound port to be deleted (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the ipv6 subnets to delete outbound ports for (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_outbound_port_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the ipv6 outbound port to be deleted')], delete_outbound_port_v6_request: Annotated[DeleteOutboundPortV6Request, FieldInfo(annotation=NoneType, required=True, description='the ipv6 subnets to delete outbound ports for')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_outbound_port_v6

delete an existing ipv6 outbound port if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the ipv6 outbound port to be deleted (required)

  • delete_outbound_port_v6_request (DeleteOutboundPortV6Request) – the ipv6 subnets to delete outbound ports for (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_outboundport(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the outbound port to be deleted')], delete_outboundport_request: Annotated[DeleteOutboundportRequest, FieldInfo(annotation=NoneType, required=True, description='the subnets to delete outbound ports for')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

delete an existing outbound port if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the outbound port to be deleted (required)

  • delete_outboundport_request (DeleteOutboundportRequest) – the subnets to delete outbound ports for (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_outboundport_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the outbound port to be deleted')], delete_outboundport_request: Annotated[DeleteOutboundportRequest, FieldInfo(annotation=NoneType, required=True, description='the subnets to delete outbound ports for')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

delete_outboundport

delete an existing outbound port if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the outbound port to be deleted (required)

  • delete_outboundport_request (DeleteOutboundportRequest) – the subnets to delete outbound ports for (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_outboundport_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the outbound port to be deleted')], delete_outboundport_request: Annotated[DeleteOutboundportRequest, FieldInfo(annotation=NoneType, required=True, description='the subnets to delete outbound ports for')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_outboundport

delete an existing outbound port if it exists, from where the feature is accessible from

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the outbound port to be deleted (required)

  • delete_outboundport_request (DeleteOutboundportRequest) – the subnets to delete outbound ports for (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_outboundports(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the outbound port to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → List[OutboundResponse]

describe the outboundports with ports and subnets

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the outbound port to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_outboundports_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the port on which we want to get the allowed ipv6 subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → List[OutboundResponse]

describe the outboundports with ports and ipv6 subnets

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the port on which we want to get the allowed ipv6 subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_outboundports_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the port on which we want to get the allowed ipv6 subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[List[splunk_acs_sdk.models.outbound_response.OutboundResponse]]

describe_outboundports_v6

describe the outboundports with ports and ipv6 subnets

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the port on which we want to get the allowed ipv6 subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_outboundports_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the port on which we want to get the allowed ipv6 subnets')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_outboundports_v6

describe the outboundports with ports and ipv6 subnets

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the port on which we want to get the allowed ipv6 subnets (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_outboundports_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the outbound port to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[List[splunk_acs_sdk.models.outbound_response.OutboundResponse]]

describe_outboundports

describe the outboundports with ports and subnets

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the outbound port to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_outboundports_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], port: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the outbound port to be deleted')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_outboundports

describe the outboundports with ports and subnets

Parameters:

  • stack (str) – the stack name (required)

  • port (int) – the outbound port to be deleted (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_outboundports(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → List[OutboundResponse]

describe the outboundports with ports and subnets

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_outboundports_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[List[splunk_acs_sdk.models.outbound_response.OutboundResponse]]

get_outboundports

describe the outboundports with ports and subnets

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_outboundports_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_outboundports

describe the outboundports with ports and subnets

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_outbound_ports_v6(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → List[OutboundResponse]

list the outboundports with ports and ipv6 subnets

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_outbound_ports_v6_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[List[splunk_acs_sdk.models.outbound_response.OutboundResponse]]

list_outbound_ports_v6

list the outboundports with ports and ipv6 subnets

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_outbound_ports_v6_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_outbound_ports_v6

list the outboundports with ports and ipv6 subnets

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.permissions_apps_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.permissions_apps_api.PermissionsAppsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

describe_permissions_apps(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → AppPerms

get an apps permissions

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_permissions_apps_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[AppPerms]

describe_permissions_apps

get an apps permissions

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_permissions_apps_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_permissions_apps

get an apps permissions

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_permissions_apps(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ListPermissionsApps200Response

List permissions of all apps

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_permissions_apps_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[ListPermissionsApps200Response]

list_permissions_apps

List permissions of all apps

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_permissions_apps_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_permissions_apps

List permissions of all apps

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_permissions_apps(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], patch_app_perms_request: Annotated[PatchAppPermsRequest, FieldInfo(annotation=NoneType, required=True, description='Modify app permissions')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

Modify an app’s permissions

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • patch_app_perms_request (PatchAppPermsRequest) – Modify app permissions (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_permissions_apps_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], patch_app_perms_request: Annotated[PatchAppPermsRequest, FieldInfo(annotation=NoneType, required=True, description='Modify app permissions')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

patch_permissions_apps

Modify an app’s permissions

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • patch_app_perms_request (PatchAppPermsRequest) – Modify app permissions (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_permissions_apps_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], app: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the app name')], patch_app_perms_request: Annotated[PatchAppPermsRequest, FieldInfo(annotation=NoneType, required=True, description='Modify app permissions')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

patch_permissions_apps

Modify an app’s permissions

Parameters:

  • stack (str) – the stack name (required)

  • app (str) – the app name (required)

  • patch_app_perms_request (PatchAppPermsRequest) – Modify app permissions (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.platform_orchestrator_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.platform_orchestrator_api.PlatformOrchestratorApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

describe_workflow(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], workflow_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Name/ID of the workflow')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → List[DescribeWorkflowResponseObject]

Get a workflow status given a workflow name

Parameters:

  • stack (str) – the stack name (required)

  • workflow_name (str) – Name/ID of the workflow (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_workflow_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], workflow_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Name/ID of the workflow')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[List[splunk_acs_sdk.models.describe_workflow_response_object.DescribeWorkflowResponseObject]]

describe_workflow

Get a workflow status given a workflow name

Parameters:

  • stack (str) – the stack name (required)

  • workflow_name (str) – Name/ID of the workflow (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_workflow_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], workflow_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Name/ID of the workflow')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_workflow

Get a workflow status given a workflow name

Parameters:

  • stack (str) – the stack name (required)

  • workflow_name (str) – Name/ID of the workflow (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.private_connectivity_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.private_connectivity_api.PrivateConnectivityApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

describe_private_connectivity(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='select which feature endpoint tried to retrieve, supported feature: search, ingest. show all if no feature specified')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → DescribePrivateConnectivity

describes the status, customerAccountIds and endpoint name

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – select which feature endpoint tried to retrieve, supported feature: search, ingest. show all if no feature specified

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_private_connectivity_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='select which feature endpoint tried to retrieve, supported feature: search, ingest. show all if no feature specified')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[DescribePrivateConnectivity]

describe_private_connectivity

describes the status, customerAccountIds and endpoint name

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – select which feature endpoint tried to retrieve, supported feature: search, ingest. show all if no feature specified

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_private_connectivity_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], feature: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='select which feature endpoint tried to retrieve, supported feature: search, ingest. show all if no feature specified')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_private_connectivity

describes the status, customerAccountIds and endpoint name

Parameters:

  • stack (str) – the stack name (required)

  • feature (str) – select which feature endpoint tried to retrieve, supported feature: search, ingest. show all if no feature specified

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

enable_private_connectivity(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], enable_private_connectivity: Annotated[EnablePrivateConnectivity, FieldInfo(annotation=NoneType, required=True, description='Customer AccountIds')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → EnablePrivateConnectivity

enables private connectivity and adds provided customerAccountIds to the private network

Parameters:

  • stack (str) – the stack name (required)

  • enable_private_connectivity (EnablePrivateConnectivity) – Customer AccountIds (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

enable_private_connectivity_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], enable_private_connectivity: Annotated[EnablePrivateConnectivity, FieldInfo(annotation=NoneType, required=True, description='Customer AccountIds')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[EnablePrivateConnectivity]

enable_private_connectivity

enables private connectivity and adds provided customerAccountIds to the private network

Parameters:

  • stack (str) – the stack name (required)

  • enable_private_connectivity (EnablePrivateConnectivity) – Customer AccountIds (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

enable_private_connectivity_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], enable_private_connectivity: Annotated[EnablePrivateConnectivity, FieldInfo(annotation=NoneType, required=True, description='Customer AccountIds')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

enable_private_connectivity

enables private connectivity and adds provided customerAccountIds to the private network

Parameters:

  • stack (str) – the stack name (required)

  • enable_private_connectivity (EnablePrivateConnectivity) – Customer AccountIds (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_private_connectivity(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], enable_private_connectivity: Annotated[EnablePrivateConnectivity, FieldInfo(annotation=NoneType, required=True, description='Customer AccountIds')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → UpdatePrivateConnectivity

updates private connectivity and patches provided customerAccountIds to the private network

Parameters:

  • stack (str) – the stack name (required)

  • enable_private_connectivity (EnablePrivateConnectivity) – Customer AccountIds (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_private_connectivity_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], enable_private_connectivity: Annotated[EnablePrivateConnectivity, FieldInfo(annotation=NoneType, required=True, description='Customer AccountIds')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[UpdatePrivateConnectivity]

update_private_connectivity

updates private connectivity and patches provided customerAccountIds to the private network

Parameters:

  • stack (str) – the stack name (required)

  • enable_private_connectivity (EnablePrivateConnectivity) – Customer AccountIds (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

update_private_connectivity_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], enable_private_connectivity: Annotated[EnablePrivateConnectivity, FieldInfo(annotation=NoneType, required=True, description='Customer AccountIds')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

update_private_connectivity

updates private connectivity and patches provided customerAccountIds to the private network

Parameters:

  • stack (str) – the stack name (required)

  • enable_private_connectivity (EnablePrivateConnectivity) – Customer AccountIds (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

validate_private_connectivity(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → DescribeEligibilityPrivateConnectivity

describe the eligibility of stack for enabling private connectivity

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

validate_private_connectivity_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[DescribeEligibilityPrivateConnectivity]

validate_private_connectivity

describe the eligibility of stack for enabling private connectivity

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

validate_private_connectivity_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

validate_private_connectivity

describe the eligibility of stack for enabling private connectivity

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.python_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.python_api.PythonApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

get_python_version(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → PythonVersionResponse

describe python version

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_python_version_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[PythonVersionResponse]

get_python_version

describe python version

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_python_version_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_python_version

describe python version

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.python_version_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.python_version_api.PythonVersionApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

change_python_version(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], change_python_version_request: Annotated[ChangePythonVersionRequest, FieldInfo(annotation=NoneType, required=True, description='python version flag')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → PythonVersionResponse

Change python version on co2 stack spec

Parameters:

  • stack (str) – the stack name (required)

  • change_python_version_request (ChangePythonVersionRequest) – python version flag (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

change_python_version_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], change_python_version_request: Annotated[ChangePythonVersionRequest, FieldInfo(annotation=NoneType, required=True, description='python version flag')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[PythonVersionResponse]

change_python_version

Change python version on co2 stack spec

Parameters:

  • stack (str) – the stack name (required)

  • change_python_version_request (ChangePythonVersionRequest) – python version flag (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

change_python_version_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], change_python_version_request: Annotated[ChangePythonVersionRequest, FieldInfo(annotation=NoneType, required=True, description='python version flag')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

change_python_version

Change python version on co2 stack spec

Parameters:

  • stack (str) – the stack name (required)

  • change_python_version_request (ChangePythonVersionRequest) – python version flag (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.restart_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.restart_api.RestartApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

restart_stack(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → RestartResponse

Restart a search head on a non-cluster stack, or initiate a rolling restart on a search-head-cluster stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

restart_stack_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[RestartResponse]

restart_stack

Restart a search head on a non-cluster stack, or initiate a rolling restart on a search-head-cluster stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

restart_stack_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

restart_stack

Restart a search head on a non-cluster stack, or initiate a rolling restart on a search-head-cluster stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

restart_status(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → RestartStatus200Response

Get rolling restart status for a search-head-cluster stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

restart_status_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[RestartStatus200Response]

restart_status

Get rolling restart status for a search-head-cluster stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

restart_status_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

restart_status

Get rolling restart status for a search-head-cluster stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.roles_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.roles_api.RolesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_role(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], post_roles_request: Annotated[PostRolesRequest, FieldInfo(annotation=NoneType, required=True, description='Role Request Body')], federated_search_manage_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Set Federated-Search-Manage-Ack to 'Y' to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment")] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → RolesResponse

create a new role on the stack

Parameters:

  • stack (str) – the stack name (required)

  • post_roles_request (PostRolesRequest) – Role Request Body (required)

  • federated_search_manage_ack (str) – Set Federated-Search-Manage-Ack to ‘Y’ to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_role_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], post_roles_request: Annotated[PostRolesRequest, FieldInfo(annotation=NoneType, required=True, description='Role Request Body')], federated_search_manage_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Set Federated-Search-Manage-Ack to 'Y' to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment")] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[RolesResponse]

create_role

create a new role on the stack

Parameters:

  • stack (str) – the stack name (required)

  • post_roles_request (PostRolesRequest) – Role Request Body (required)

  • federated_search_manage_ack (str) – Set Federated-Search-Manage-Ack to ‘Y’ to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_role_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], post_roles_request: Annotated[PostRolesRequest, FieldInfo(annotation=NoneType, required=True, description='Role Request Body')], federated_search_manage_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Set Federated-Search-Manage-Ack to 'Y' to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment")] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

create_role

create a new role on the stack

Parameters:

  • stack (str) – the stack name (required)

  • post_roles_request (PostRolesRequest) – Role Request Body (required)

  • federated_search_manage_ack (str) – Set Federated-Search-Manage-Ack to ‘Y’ to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_role(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], role_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='role name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

delete a specific role

Parameters:

  • stack (str) – the stack name (required)

  • role_name (str) – role name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_role_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], role_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='role name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

delete_role

delete a specific role

Parameters:

  • stack (str) – the stack name (required)

  • role_name (str) – role name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_role_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], role_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='role name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_role

delete a specific role

Parameters:

  • stack (str) – the stack name (required)

  • role_name (str) – role name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_role(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], role_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='role name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → RolesResponse

describe a specific role

Parameters:

  • stack (str) – the stack name (required)

  • role_name (str) – role name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_role_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], role_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='role name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[RolesResponse]

describe_role

describe a specific role

Parameters:

  • stack (str) – the stack name (required)

  • role_name (str) – role name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_role_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], role_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='role name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_role

describe a specific role

Parameters:

  • stack (str) – the stack name (required)

  • role_name (str) – role name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_roles(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ListRoles200Response

list all roles

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_roles_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[ListRoles200Response]

list_roles

list all roles

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_roles_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_roles

list all roles

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_role_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], role_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='role name')], roles_request: Annotated[RolesRequest, FieldInfo(annotation=NoneType, required=True, description='Modify role object info')], federated_search_manage_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Set Federated-Search-Manage-Ack to 'Y' to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment")] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → RolesResponse

Modify a specific role on the stack

Parameters:

  • stack (str) – the stack name (required)

  • role_name (str) – role name (required)

  • roles_request (RolesRequest) – Modify role object info (required)

  • federated_search_manage_ack (str) – Set Federated-Search-Manage-Ack to ‘Y’ to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_role_info_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], role_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='role name')], roles_request: Annotated[RolesRequest, FieldInfo(annotation=NoneType, required=True, description='Modify role object info')], federated_search_manage_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Set Federated-Search-Manage-Ack to 'Y' to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment")] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[RolesResponse]

patch_role_info

Modify a specific role on the stack

Parameters:

  • stack (str) – the stack name (required)

  • role_name (str) – role name (required)

  • roles_request (RolesRequest) – Modify role object info (required)

  • federated_search_manage_ack (str) – Set Federated-Search-Manage-Ack to ‘Y’ to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_role_info_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], role_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='role name')], roles_request: Annotated[RolesRequest, FieldInfo(annotation=NoneType, required=True, description='Modify role object info')], federated_search_manage_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Set Federated-Search-Manage-Ack to 'Y' to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment")] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

patch_role_info

Modify a specific role on the stack

Parameters:

  • stack (str) – the stack name (required)

  • role_name (str) – role name (required)

  • roles_request (RolesRequest) – Modify role object info (required)

  • federated_search_manage_ack (str) – Set Federated-Search-Manage-Ack to ‘Y’ to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.system_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.system_api.SystemApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

describe_deployment(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], deployment_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='deployment ID')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → RetryDeployment200Response

describe the deployment status of the stack

Parameters:

  • stack (str) – the stack name (required)

  • deployment_id (str) – deployment ID (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_deployment_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], deployment_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='deployment ID')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[RetryDeployment200Response]

describe_deployment

describe the deployment status of the stack

Parameters:

  • stack (str) – the stack name (required)

  • deployment_id (str) – deployment ID (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_deployment_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], deployment_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='deployment ID')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_deployment

describe the deployment status of the stack

Parameters:

  • stack (str) – the stack name (required)

  • deployment_id (str) – deployment ID (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_stack(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → DescribeStack200Response

describe the generic information about the stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_stack_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[DescribeStack200Response]

describe_stack

describe the generic information about the stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_stack_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_stack

describe the generic information about the stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_deployment(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ListDeployment200Response

describe the deployment status of the stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_deployment_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[ListDeployment200Response]

list_deployment

describe the deployment status of the stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_deployment_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_deployment

describe the deployment status of the stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

retry_deployment(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → RetryDeployment200Response

retry a specific deployment id of a stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

retry_deployment_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[RetryDeployment200Response]

retry_deployment

retry a specific deployment id of a stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

retry_deployment_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

retry_deployment

retry a specific deployment id of a stack

Parameters:

  • stack (str) – the stack name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.tokens_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.tokens_api.TokensApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_token(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], token_body: Annotated[TokenBody, FieldInfo(annotation=NoneType, required=True, description='Token Post Body')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → CreateToken200Response

create a token to authenticate against ACS

Parameters:

  • stack (str) – the stack name (required)

  • token_body (TokenBody) – Token Post Body (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_token_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], token_body: Annotated[TokenBody, FieldInfo(annotation=NoneType, required=True, description='Token Post Body')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[CreateToken200Response]

create_token

create a token to authenticate against ACS

Parameters:

  • stack (str) – the stack name (required)

  • token_body (TokenBody) – Token Post Body (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_token_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], token_body: Annotated[TokenBody, FieldInfo(annotation=NoneType, required=True, description='Token Post Body')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

create_token

create a token to authenticate against ACS

Parameters:

  • stack (str) – the stack name (required)

  • token_body (TokenBody) – Token Post Body (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_token(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], token_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='token ID')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

delete token on the stack

Parameters:

  • stack (str) – the stack name (required)

  • token_id (str) – token ID (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_token_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], token_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='token ID')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

delete_token

delete token on the stack

Parameters:

  • stack (str) – the stack name (required)

  • token_id (str) – token ID (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_token_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], token_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='token ID')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_token

delete token on the stack

Parameters:

  • stack (str) – the stack name (required)

  • token_id (str) – token ID (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_token_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], token_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='token ID')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → CreateToken200Response

get token info

Parameters:

  • stack (str) – the stack name (required)

  • token_id (str) – token ID (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_token_info_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], token_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='token ID')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[CreateToken200Response]

get_token_info

get token info

Parameters:

  • stack (str) – the stack name (required)

  • token_id (str) – token ID (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_token_info_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], token_id: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='token ID')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

get_token_info

get token info

Parameters:

  • stack (str) – the stack name (required)

  • token_id (str) – token ID (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_tokens(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, status: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='status of tokens wanted')] = None, username: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='user of tokens wanted')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ListTokens200Response

get all tokens

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • status (str) – status of tokens wanted

  • username (str) – user of tokens wanted

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_tokens_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, status: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='status of tokens wanted')] = None, username: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='user of tokens wanted')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[ListTokens200Response]

list_tokens

get all tokens

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • status (str) – status of tokens wanted

  • username (str) – user of tokens wanted

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_tokens_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, status: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='status of tokens wanted')] = None, username: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='user of tokens wanted')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_tokens

get all tokens

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • status (str) – status of tokens wanted

  • username (str) – user of tokens wanted

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

splunk_acs_sdk.api.users_api module

Splunk Cloud Admin API

API for managing splunk cloud stacks. (c) 2020 Splunk Inc. All rights reserved. I acknowledge that Splunk is not responsible for the installation or use of any application that is not a supported Splunk application and Splunk specifically disclaims the accuracy, integrity, quality, legality, usefulness or security of such application or its use. Installation and use of an application that is not a supported Splunk application is at your own risk. Please note that if data leaves Splunk Cloud as a result of installing or using such application, Splunk’s security attestations do not apply to data outside Splunk Cloud. Learn more about installing private apps (link to https://docs.splunk.com/Documentation/SplunkCloud/8.2.2109/Config/ManageApps). Access and use is subject to the Splunk General Terms (https://www.splunk.com/en_us/legal/splunk-general-terms.html) and Splunk’s Website Terms and Conditions (https://www.splunk.com/en_us/legal/terms/terms-of-use.html).

The version of the OpenAPI document: v2 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class splunk_acs_sdk.api.users_api.UsersApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

create_user(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], create_user_request: Annotated[CreateUserRequest, FieldInfo(annotation=NoneType, required=True, description='Create User Request Body')], federated_search_manage_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Set Federated-Search-Manage-Ack to 'Y' to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment")] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → UsersResponse

create a new user

Parameters:

  • stack (str) – the stack name (required)

  • create_user_request (CreateUserRequest) – Create User Request Body (required)

  • federated_search_manage_ack (str) – Set Federated-Search-Manage-Ack to ‘Y’ to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_user_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], create_user_request: Annotated[CreateUserRequest, FieldInfo(annotation=NoneType, required=True, description='Create User Request Body')], federated_search_manage_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Set Federated-Search-Manage-Ack to 'Y' to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment")] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[UsersResponse]

create_user

create a new user

Parameters:

  • stack (str) – the stack name (required)

  • create_user_request (CreateUserRequest) – Create User Request Body (required)

  • federated_search_manage_ack (str) – Set Federated-Search-Manage-Ack to ‘Y’ to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_user_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], create_user_request: Annotated[CreateUserRequest, FieldInfo(annotation=NoneType, required=True, description='Create User Request Body')], federated_search_manage_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Set Federated-Search-Manage-Ack to 'Y' to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment")] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

create_user

create a new user

Parameters:

  • stack (str) – the stack name (required)

  • create_user_request (CreateUserRequest) – Create User Request Body (required)

  • federated_search_manage_ack (str) – Set Federated-Search-Manage-Ack to ‘Y’ to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_user(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], user_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='user name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → None

delete a specific user

Parameters:

  • stack (str) – the stack name (required)

  • user_name (str) – user name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_user_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], user_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='user name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[NoneType]

delete_user

delete a specific user

Parameters:

  • stack (str) – the stack name (required)

  • user_name (str) – user name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_user_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], user_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='user name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

delete_user

delete a specific user

Parameters:

  • stack (str) – the stack name (required)

  • user_name (str) – user name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_user(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], user_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='user name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → UsersResponse

describe a specific user

Parameters:

  • stack (str) – the stack name (required)

  • user_name (str) – user name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_user_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], user_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='user name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[UsersResponse]

describe_user

describe a specific user

Parameters:

  • stack (str) – the stack name (required)

  • user_name (str) – user name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

describe_user_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], user_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='user name')], _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

describe_user

describe a specific user

Parameters:

  • stack (str) – the stack name (required)

  • user_name (str) – user name (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_users(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ListUsers200Response

list all users

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_users_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[ListUsers200Response]

list_users

list all users

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_users_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], count: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None, FieldInfo(annotation=NoneType, required=True, description='The maximum number of results to return.')] = None, offset: Annotated[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, FieldInfo(annotation=NoneType, required=True, description='The offset to start returning items from.')] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

list_users

list all users

Parameters:

  • stack (str) – the stack name (required)

  • count (int) – The maximum number of results to return.

  • offset (int) – The offset to start returning items from.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_user(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], user_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='user name')], patch_user_request: Annotated[PatchUserRequest, FieldInfo(annotation=NoneType, required=True, description='Modify user object info')], federated_search_manage_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Set Federated-Search-Manage-Ack to 'Y' to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment")] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → UsersResponse

Modify a specific user on the stack

Parameters:

  • stack (str) – the stack name (required)

  • user_name (str) – user name (required)

  • patch_user_request (PatchUserRequest) – Modify user object info (required)

  • federated_search_manage_ack (str) – Set Federated-Search-Manage-Ack to ‘Y’ to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_user_with_http_info(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], user_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='user name')], patch_user_request: Annotated[PatchUserRequest, FieldInfo(annotation=NoneType, required=True, description='Modify user object info')], federated_search_manage_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Set Federated-Search-Manage-Ack to 'Y' to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment")] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → ApiResponse[UsersResponse]

patch_user

Modify a specific user on the stack

Parameters:

  • stack (str) – the stack name (required)

  • user_name (str) – user name (required)

  • patch_user_request (PatchUserRequest) – Modify user object info (required)

  • federated_search_manage_ack (str) – Set Federated-Search-Manage-Ack to ‘Y’ to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_user_without_preload_content(stack: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='the stack name')], user_name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='user name')], patch_user_request: Annotated[PatchUserRequest, FieldInfo(annotation=NoneType, required=True, description='Modify user object info')], federated_search_manage_ack: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Set Federated-Search-Manage-Ack to 'Y' to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment")] = None, _request_timeout: None | Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[float, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → HTTPResponse

patch_user

Modify a specific user on the stack

Parameters:

  • stack (str) – the stack name (required)

  • user_name (str) – user name (required)

  • patch_user_request (PatchUserRequest) – Modify user object info (required)

  • federated_search_manage_ack (str) – Set Federated-Search-Manage-Ack to ‘Y’ to acknowledge your acceptance that roles with fsh_manage capability can send search results data outside the compliant environment

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

Module contents